﻿/*----------------------------------------------------------------------------------------
*
*  Copyright 2019, Gao Hai Hui, <fromzeropoint@126.com>.  All rights reserved.
*  https://gitee.com/helloworldghh/xoskit.git
*  Use of this source code is governed by a MIT license
*  that can be found in the License file.
*
----------------------------------------------------------------------------------------*/
#ifndef __08B1EE48_7C6C_4ec1_A8F8_0B5A9A856673__
#define __08B1EE48_7C6C_4ec1_A8F8_0B5A9A856673__

namespace xos_container
{
    class i_container;
}

namespace xos_common
{
    class i_property;
    class i_common;
}

namespace xos_box
{
    class i_property;
    class i_variant;
}

namespace xos_xml
{

    /////////////////////////////////////////////////////////////////////////////////
    // 
    // 定义解析xml的回调函数
    // 
    typedef int ( *f_value )( const char * lpszKey, const char * lpszValue );
    typedef int ( *f_node )( const char * lpszNodeName );

    /////////////////////////////////////////////////////////////////////////////////
    // 
    // xml节点接口
    // 
    class i_xml_node : public xos::i_release
    {
    public:
        virtual ~i_xml_node(){}

    public:
        // 
        // 返出指定名称的节点
        // 
        virtual int select_single_node( const char * lpszNodeName, i_xml_node ** ppv ) = 0;

        // 
        // 将节点及之下内容保存成字串
        // 
        virtual int save_xml_string( char * lpszXml, int nLen, int * lpnLenNeeded ) = 0;

        // 
        // 返出指定名称的节点.所有权归节点自己.但是要在父节点释放前,释放.
        // 
        virtual int get_parent_node( i_xml_node ** ppv ) = 0;
        virtual int get_child_node( i_xml_node ** ppv ) = 0;

        // 
        // 兄弟节点
        // 
        virtual int get_prev_sibling_node( i_xml_node ** ppv ) = 0;
        virtual int get_next_sibling_node( i_xml_node ** ppv ) = 0;

        // 节点属性
        virtual int get_node_prop( char * lpszName, int nNameLen, int * lpnNameLenNeed, char * lpszProp, int nPropLen, int * lpnPropLenNeed ) = 0;
        virtual int get_node_prop( const char * lpszName, char * lpszProp, int nLen, int * lpnLenNeed ) = 0;
        virtual int set_node_prop( const char * lpszName, const char * lpszProp ) = 0;
        virtual int reset_property() = 0;
        virtual int next_property() = 0;

        // 
        // 节点名称,属性
        // 
        virtual int get_node_name( char * lpszName, int nLen, int * lpnLenNeed ) = 0;
        virtual int set_node_name( const char * lpszName ) = 0;
        virtual int get_node_value( char * lpszValue, int nLen, int * lpnLenNeed ) = 0;
        virtual int set_node_value( const char * lpszValue ) = 0;

        // 
        // 创建并添加节点.节点所有者为上级节点
        // 
        virtual int create_and_append_node( const char * lpszNodeName, i_xml_node ** ppv ) = 0;
        virtual int create_node( const char * lpszNodeName, i_xml_node ** ppv ) = 0;
        virtual int append_node( i_xml_node * pv ) = 0;
        virtual int remove_node( i_xml_node * pv ) = 0;

        // 
        // 克隆节点
        // 
        virtual int clone( i_xml_node ** ppv ) = 0;
    };

    /////////////////////////////////////////////////////////////////////////////////
    // 
    // xml文档接口,xml要求是utf-8格式
    // 
    class i_xml_doc : public xos::i_release
    {
    public:
        virtual ~i_xml_doc(){}

    public:
        // 
        // 载入XML
        // 
        virtual int load_xml_string( const char * lpszXml ) = 0;
        virtual int load_xml_file( const char * lpszXml ) = 0;

        // 
        // 保存XML
        // 
        virtual int save_xml_string( char * lpszXml, int nLen, int * lpnLenNeeded ) = 0;
        virtual int save_xml_file( const char * lpszFile ) = 0;

        // 
        // 返回根节点
        // 
        virtual int get_root_node( i_xml_node ** ppv ) = 0;

        // 
        // 创建并添加节点
        // 
        virtual int create_and_append_node( const char * lpszNodeName, i_xml_node ** ppv ) = 0;
        virtual int create_node( const char * lpszNodeName, i_xml_node ** ppv ) = 0;
        virtual int append_node( i_xml_node * pv ) = 0;
        virtual int remove_node( i_xml_node * pv ) = 0;
    };

    /////////////////////////////////////////////////////////////////////////////////
    // 
    // i_xml_mgr
    // 
    class i_xml_mgr : public xos::i_release
    {
    public:
        virtual ~i_xml_mgr(){}

    public:
        // 
        // load and parse xml to xos_box::i_property
        // 
        virtual int load_xml( const char * lpszFile, f_node lpfNode, f_value lpfValue, xos_box::i_variant ** ppvt, xos_box::i_property ** ppv ) = 0;

        // 
        // create node
        // 
        virtual int create_node( i_xml_node ** ppv ) = 0;

        // 
        // create doc
        // 
        virtual int create_doc( i_xml_doc ** ppv ) = 0;
    };

    /////////////////////////////////////////////////////////////////////////////////
    // 
    // export function
    // 
    typedef int ( * f_create )( xos_container::i_container * pContainer, i_xml_mgr ** ppv );

} // xos_xml

#endif // __08B1EE48_7C6C_4ec1_A8F8_0B5A9A856673__
